
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package telemetry.internal.platform.tracing_agent</title>
<meta charset="utf-8">
</head><body bgcolor="#f0f0f8">

<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.platform.html"><font color="#ffffff">platform</font></a>.tracing_agent</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/platform/tracing_agent/__init__.py">telemetry/internal/platform/tracing_agent/__init__.py</a></font></td></tr></table>
    <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
#&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
#&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
    
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="telemetry.internal.platform.tracing_agent.chrome_tracing_agent.html">chrome_tracing_agent</a><br>
<a href="telemetry.internal.platform.tracing_agent.chrome_tracing_agent_unittest.html">chrome_tracing_agent_unittest</a><br>
</td><td width="25%" valign=top><a href="telemetry.internal.platform.tracing_agent.chrome_tracing_devtools_manager.html">chrome_tracing_devtools_manager</a><br>
<a href="telemetry.internal.platform.tracing_agent.display_tracing_agent.html">display_tracing_agent</a><br>
</td><td width="25%" valign=top><a href="telemetry.internal.platform.tracing_agent.display_tracing_agent_unittest.html">display_tracing_agent_unittest</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
    
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="telemetry.internal.platform.tracing_agent.html#TracingAgent">TracingAgent</a>
</font></dt></dl>
</dd>
</dl>
 <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="TracingAgent">class <strong>TracingAgent</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
    
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt>A&nbsp;tracing&nbsp;agent&nbsp;provided&nbsp;by&nbsp;the&nbsp;platform.<br>
&nbsp;<br>
A&nbsp;tracing&nbsp;agent&nbsp;can&nbsp;gather&nbsp;data&nbsp;with&nbsp;<a href="#TracingAgent-Start">Start</a>()&nbsp;until&nbsp;<a href="#TracingAgent-Stop">Stop</a>().<br>
Before&nbsp;constructing&nbsp;an&nbsp;<a href="#TracingAgent">TracingAgent</a>,&nbsp;check&nbsp;whether&nbsp;it's&nbsp;supported&nbsp;on&nbsp;the<br>
platform&nbsp;with&nbsp;IsSupported&nbsp;method&nbsp;first.<br>
&nbsp;<br>
NOTE:&nbsp;All&nbsp;subclasses&nbsp;of&nbsp;<a href="#TracingAgent">TracingAgent</a>&nbsp;must&nbsp;not&nbsp;change&nbsp;the&nbsp;constructor's<br>
parameters&nbsp;so&nbsp;the&nbsp;agents&nbsp;can&nbsp;be&nbsp;dynamically&nbsp;constructed&nbsp;in<br>
tracing_controller_backend.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="TracingAgent-Start"><strong>Start</strong></a>(self, trace_options, category_filter, timeout)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;tracing&nbsp;agent's&nbsp;custom&nbsp;logic&nbsp;to&nbsp;start&nbsp;tracing.<br>
&nbsp;<br>
Depending&nbsp;on&nbsp;trace_options&nbsp;and&nbsp;category_filter,&nbsp;the&nbsp;tracing&nbsp;agent&nbsp;may&nbsp;choose<br>
to&nbsp;start&nbsp;or&nbsp;not&nbsp;start&nbsp;tracing.<br>
&nbsp;<br>
Args:<br>
&nbsp;&nbsp;trace_options:&nbsp;an&nbsp;instance&nbsp;of&nbsp;tracing_options.TracingOptions&nbsp;that<br>
&nbsp;&nbsp;&nbsp;&nbsp;control&nbsp;which&nbsp;core&nbsp;tracing&nbsp;systems&nbsp;should&nbsp;be&nbsp;enabled.<br>
&nbsp;&nbsp;category_filter:&nbsp;an&nbsp;instance&nbsp;of<br>
&nbsp;&nbsp;&nbsp;&nbsp;tracing_category_filter.TracingCategoryFilter<br>
&nbsp;&nbsp;timeout:&nbsp;number&nbsp;of&nbsp;seconds&nbsp;that&nbsp;this&nbsp;tracing&nbsp;agent&nbsp;should&nbsp;try&nbsp;to&nbsp;start<br>
&nbsp;&nbsp;&nbsp;&nbsp;tracing&nbsp;until&nbsp;time&nbsp;out.<br>
&nbsp;<br>
Returns:<br>
&nbsp;&nbsp;True&nbsp;if&nbsp;tracing&nbsp;agent&nbsp;started&nbsp;succesfully.</tt></dd></dl>

<dl><dt><a name="TracingAgent-Stop"><strong>Stop</strong></a>(self, trace_data_builder)</dt><dd><tt>Override&nbsp;to&nbsp;add&nbsp;tracing&nbsp;agent's&nbsp;custom&nbsp;logic&nbsp;to&nbsp;stop&nbsp;tracing.<br>
&nbsp;<br>
<a href="#TracingAgent-Stop">Stop</a>()&nbsp;should&nbsp;guarantee&nbsp;tracing&nbsp;is&nbsp;stopped,&nbsp;even&nbsp;if&nbsp;there&nbsp;may&nbsp;be&nbsp;exception.</tt></dd></dl>

<dl><dt><a name="TracingAgent-__init__"><strong>__init__</strong></a>(self, platform_backend)</dt></dl>

<hr>
Class methods defined here:<br>
<dl><dt><a name="TracingAgent-IsSupported"><strong>IsSupported</strong></a>(cls, _platform_backend)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>

<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table></td></tr></table>
</body></html>